<!DOCTYPE html>
<html>

<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
  <title>layuiAdmin【单页版】开发者文档</title>
  <meta name="description" content="">
  <link rel="stylesheet" href="//at.alicdn.com/t/font_24081_qs69ykjbea.css">
  <link rel="stylesheet" href="/layui/css/layui.css?t=1568266997720">
  <link rel="stylesheet" href="/layuiadmindoc/global.css?t=15682669977206" charset="utf-8">
  <link rel="stylesheet" href="/layuiadmindoc/docs.css?t=1568266997720" charset="utf-8">
  <style>
    .fly-footer {
      border: none;
    }
  </style>
</head>

<body class="fly-body-docs">
  <div class="layui-container">
    <div class="fly-docs-container">
      <h1 class="fly-docs-title">layuiAdmin pro v1.x 【单页版】开发者文档</h1>
      <div class="layui-text fly-md-text" data-doc="0.00033892830308424754">
        <div class="layui-btn-container">
          <a href="/docs/3/" class="layui-btn">更新日志</a> <a href="/docs/6/" target="_blank" class="layui-btn">常见问题</a> <a
            href="http://www.layui.com/admin/pro/" target="_blank" class="layui-btn">在线演示</a> <a
            href="/vipclub/list/layuiadmin/" target="_blank" class="layui-btn">会员专区</a> <a href="/docs/4/"
            class="layui-btn layui-btn-primary">切换到：iframe版文档</a>
        </div>
        <br>
        <blockquote>
          <p>layuiAdmin pro （单页版）是完全基于 layui 架构而成的后台管理模板系统，可以更轻松地实现前后端分离，它是 mvc 的简化版，全面接管 <em>视图</em> 和
            <em>页面路由</em>，并可自主完成数据渲染，服务端通常只负责数据接口，而前端只需专注视图和事件交互，所有的页面动作都是在一个宿主页面中完成，因此这赋予了 layuiAdmin 单页面应用开发的能力。</p>
        </blockquote>
        <div class="fly-md-dir">
          <ul>
            <li>
              <p><a href="#quickstart">快速上手</a></p>
              <ul>
                <li><a href="#deploy">部署</a></li>
                <li><a href="#dir-desc">目录说明</a></li>
                <li><a href="#start-page">宿主页面</a></li>
                <li><a href="#config">全局配置</a></li>
                <li><a href="#menu">侧边菜单</a></li>
              </ul>
            </li>
            <li>
              <p><a href="#router">路由</a></p>
              <ul>
                <li><a href="#router-rules">路由规则</a></li>
                <li><a href="#router-jump">路由跳转</a></li>
                <li><a href="#router-end">路由结尾</a></li>
              </ul>
            </li>
            <li>
              <p><a href="#views">视图</a></p>
              <ul>
                <li><a href="#views-router">视图与路由的关系</a></li>
                <li><a href="#views-js">视图中加载 JS 模块</a></li>
              </ul>
            </li>
            <li>
              <p><a href="#template">动态模板</a></p>
              <ul>
                <li><a href="#template-set">定义模板</a></li>
                <li><a href="#template-attrs">模板基础属性</a></li>
                <li><a href="#template-syntax">模板语法</a></li>
              </ul>
            </li>
            <li>
              <p><a href="#login-auth">登录与接口鉴权</a></p>
            </li>
            <li>
              <p><a href="#base-mehod">基础方法</a></p>
              <ul>
                <li><a href="#base-admin">admin模块</a></li>
                <li><a href="#base-view">view模块</a></li>
              </ul>
            </li>
            <li>
              <p><a href="#id">ID 唯一性</a></p>
            </li>
            <li>
              <p><a href="#util">实用组件</a></p>
            </li>
            <li>
              <p><a href="#on">事件监听</a></p>
            </li>
            <li>
              <p><a href="#compatibility">兼容性</a></p>
            </li>
            <li>
              <p><a href="#cache">缓存问题</a></p>
            </li>
            <li>
              <p><a href="#update">升级事项</a></p>
            </li>
            <li>
              <p><a href="#build">源码构建</a></p>
            </li>
            <li>
              <p><a href="#copyright">关于版权</a></p>
            </li>
          </ul>
          <hr>
        </div>
        <h2>题外</h2>
        <ul>
          <li>该文档适用于 <strong>layuiAdmin 专业版（单页面）</strong>，阅读之前请务必确认是否与你使用的版本对应。</li>
          <li>熟练掌握 layuiAdmin 的前提是熟练掌握 layui，因此除了本篇文档， <a href="http://www.layui.com/doc/">layui 的文档</a> 也是必不可少的存在。</li>
        </ul>
        <p><a name="quickstart"> </a></p>
        <h2>快速上手</h2>
        <p><a name="deploy"> </a></p>
        <h3>部署</h3>
        <ol>
          <li>解压文件后，将 <em>layuiAdmin</em> 完整放置在任意目录</li>
          <li>通过本地 web 服务器去访问 <em>./start/index.html</em> 即可运行 Demo</li>
        </ol>
        <blockquote>
          <p>由于 layuiAdmin 可采用前后端分离开发模式，因此你无需将其放置在你的服务端 MVC 框架中，你只需要给 layuiAdmin
            主入口页面（我们也称之为：<em>宿主页面</em>）进行访问解析，它即可全权完成自身路由的跳转和视图的呈现，而数据层则完全通过服务端提供的异步接口来完成。</p>
        </blockquote>
        <p><a name="dir-desc"> </a></p>
        <h3>目录说明</h3>
        <ul>
          <li>
            <p><strong>src/</strong><br>
              layuiAdmin 源代码，通常用于开发环境（如本地），推荐你在本地开发时，将 <em>./start/index.html</em> 中的 <code>layui.css</code> 和
              <code>layui.js</code> 的引入路径由 dist 改为 src 目录。</p>
            <ul>
              <li><strong>src/controller/</strong>：存放 JS 业务模块，即对视图进行事件等交互性处理</li>
              <li><strong>src/lib/</strong>：layuiAdmin 的核心模块，一般不推荐修改</li>
              <li><strong>src/style/</strong>：存放样式，其中 <em>admin.css</em>是核心样式</li>
              <li><strong>src/views/</strong>：存放视图文件。其中 <em>layout.html</em> 是整个框架结构的承载，一般不推荐做大量改动。</li>
              <li><strong>src/config.js</strong>：layuiAdmin 的全局配置文件，可随意修改。</li>
              <li><strong>src/index.js</strong>：layuiAdmin 的入口模块，一般不推荐修改</li>
            </ul>
          </li>
          <li>
            <p><strong>dist/</strong><br>
              通过 gulp 将 layuiAdmin src 目录的源代码进行构建后生成的目录（即：将 JS 和 CSS 文件进行了压缩等处理），通常用于线上环境。关于 gulp 的使用，下文也有介绍。</p>
          </li>
          <li>
            <p><strong>start/</strong><br>
              存放 layuiAdmin 的入口页面、模拟接口数据、layui</p>
          </li>
        </ul>
        <p><a name="start-page"> </a></p>
        <h3>宿主页面</h3>
        <p>你所看到的 <em>start/index.html</em> 是我们提供好的宿主页面，它是整个单页面的承载，所有的界面都是在这一个页面中完成跳转和渲染的。事实上，宿主页面可以放在任何地方，但是要注意修改里面的
          <code>&lt;link&gt;</code> <code>&lt;script&gt;</code> 的 src 和 layui.config 中 <code>base</code> 的路径。</p>
        <p><a name="config"> </a></p>
        <h3>全局配置</h3>
        <p>当你已经顺利在本地预览了 layuiAdmin 后，你一定迫不及待关注更深层的结构。打开 src 目录，你将看到
          <code>config.js</code>，里面存储着所有的默认配置。你可以按照实际需求选择性修改，下面是 layuiAdmin 默认提供的配置：</p>
        <pre><code>layui.define(['laytpl', 'layer', 'element', 'util'], function(exports){
    exports('setter', {
      container: 'LAY_app' //容器ID
      ,base: layui.cache.base //记录layuiAdmin文件夹所在路径
      ,views: layui.cache.base + 'views/' //视图所在目录
      ,entry: 'index' //默认视图文件名
      ,engine: '.html' //视图文件后缀名
      ,pageTabs: false //是否开启页面选项卡功能。单页版不推荐开启

      ,name: 'layuiAdmin Pro'
      ,tableName: 'layuiAdmin' //本地存储表名
      ,MOD_NAME: 'admin' //模块事件名

      ,debug: true //是否开启调试模式。如开启，接口异常时会抛出异常 URL 等信息

      ,interceptor: false //是否开启未登入拦截

      //自定义请求字段
      ,request: {
        tokenName: 'access_token' //自动携带 token 的字段名。可设置 false 不携带。
      }

      //自定义响应字段
      ,response: {
        statusName: 'code' //数据状态的字段名称
        ,statusCode: {
          ok: 0 //数据状态一切正常的状态码
          ,logout: 1001 //登录状态失效的状态码
        }
        ,msgName: 'msg' //状态信息的字段名称
        ,dataName: 'data' //数据详情的字段名称
      }

      //独立页面路由，可随意添加（无需写参数）
      ,indPage: [
        '/user/login' //登入页
        ,'/user/reg' //注册页
        ,'/user/forget' //找回密码
        ,'/template/tips/test' //独立页的一个测试 demo
      ]

      //扩展的第三方模块
      ,extend: [
        'echarts', //echarts 核心包
        'echartsTheme' //echarts 主题
      ]

      //主题配置
      ,theme: {
        //配色方案，如果用户未设置主题，第一个将作为默认
        color: [{
          main: '#20222A' //主题色
          ,selected: '#009688' //选中色
          ,logo: '' //logo区域背景色
          ,header: '' //头部区域背景色
          ,alias: 'default' //默认别名
        }] //为了减少篇幅，更多主题此处不做列举，可直接参考 config.js

        //初始的颜色索引，对应上面的配色方案数组索引
        //如果本地已经有主题色记录，则以本地记录为优先，除非清除 localStorage（步骤：F12呼出调试工具→Aplication→Local Storage→选中页面地址→layuiAdmin→再点上面的X）
        // 1.0 正式版开始新增
        ,initColorIndex: 0
      }
    });
  });
  </code></pre>
        <p><a name="menu"> </a></p>
        <h3>侧边菜单</h3>
        <ul>
          <li>在 <strong>start/json/menu.js</strong> 文件中，我们放置了默认的侧边菜单数据，你可以去随意改动它。</li>
          <li>如果你需要动态加载菜单，你需要将 <strong>views/layout.html</strong> 中的对应地址改成你的真实接口地址</li>
        </ul>
        <p>侧边菜单最多可支持到三级。无论你采用静态的菜单还是动态的，菜单的数据格式都必须是一段合法的 JSON，且必须符合以下规范：</p>
        <pre><code>{
    &quot;code&quot;: 0 //状态码，key 名可以通过 config.js 去重新配置
    ,&quot;msg&quot;: &quot;&quot; //提示信息
    ,&quot;data&quot;: [{ //菜单数据，key名可以通过 config.js 去重新配置
      &quot;name&quot;: &quot;component&quot; //一级菜单名称（与视图的文件夹名称和路由路径对应）
      ,&quot;title&quot;: &quot;组件&quot; //一级菜单标题
      ,&quot;icon&quot;: &quot;layui-icon-component&quot; //一级菜单图标样式
      ,&quot;jump&quot;: '' //自定义一级菜单路由地址，默认按照 name 解析。一旦设置，将优先按照 jump 设定的路由跳转
      ,&quot;spread&quot;: true //是否默认展子菜单（1.0.0-beta9 新增）
      ,&quot;list&quot;: [{ //二级菜单
        &quot;name&quot;: &quot;grid&quot; //二级菜单名称（与视图的文件夹名称和路由路径对应）
        ,&quot;title&quot;: &quot;栅格&quot; //二级菜单标题
        ,&quot;jump&quot;: ''  //自定义二级菜单路由地址
        ,&quot;spread&quot;: true //是否默认展子菜单（1.0.0-beta9 新增）
        ,&quot;list&quot;: [{ //三级菜单
          &quot;name&quot;: &quot;list&quot; //三级菜单名（与视图中最终的文件名和路由对应），如：component/grid/list
          ,&quot;title&quot;: &quot;等比例列表排列&quot; //三级菜单标题
        },{
          &quot;name&quot;: &quot;mobile&quot;
          ,&quot;title&quot;: &quot;按移动端排列&quot;
        }
      }]
  }
  </code></pre>
        <blockquote>
          <p>TIPS：实际运用时，切勿出现上述中的注释，否则将不是合法的 JSON ，会出现解析错误。</p>
        </blockquote>
        <p>需要注意的是以下几点：</p>
        <ol>
          <li>当任意级菜单有子菜单，点击该菜单都只是收缩和展开操作，而并不会跳转，只有没有子菜单的菜单才被允许跳转。</li>
          <li>菜单的路由地址默认是按照菜单层级的 name 来设定的。<br>
            我们假设一级菜单的 name 是：<code>a</code>，二级菜单的是：<code>b</code>，三级菜单的 name 是 <code>c</code>，那么：
            <ul>
              <li>三级菜单最终的路由地址就是：<code>/a/b/c</code></li>
              <li>如果二级菜单没有三级菜单，那么二级菜单就是最终路由，地址就是：<code>/a/b/</code></li>
              <li>如果一级菜单没有二级菜单，那么一级菜单就是最终路由，地址就是：<code>/a/</code></li>
            </ul>
          </li>
          <li>但如果你设置了 参数 <em>jump</em>，那么就会优先读取 jump 设定的路由地址，如：<code>&quot;jump&quot;: &quot;/user/set&quot;</code></li>
        </ol>
        <p><a name="router"> </a></p>
        <h2>路由</h2>
        <p>layuiAdmin 的路由是采用 <em>location.hash</em> 的机制，即路由地址是放在 <code>./#/</code> 后面，并通过 layui 自带的方法：
          <code>layui.router()</code> 来进行解析。每一个路由都对应一个真实存在的视图文件，且路由地址和视图文件的路径是一致的（相对 <em>views</em>
          目录）。因此，你不再需要通过配置服务端的路由去访问一个页面，也无需在 layuiAdmin 内部代码中去定义路由，而是直接通过 layuiAdmin 的前端路由去访问，即可匹配相应目录的视图，从而呈现出页面结果。</p>
        <p><a name="router-rules"> </a></p>
        <h3>路由规则</h3>
        <pre><code>./#/path1/path2/path3/key1=value1/key2=value2…
  </code></pre>
        <p>一个实际的示例：</p>
        <pre><code>./#/user/set
  ./#/user/set/uid=123/type=1#xxx（下面将以这个为例继续讲解）
  </code></pre>
        <p>当你需要对路由结构进行解析时，你只需要通过 layui 内置的方法 <code>layui.router()</code> 即可完成。如上面的路由解析出来的结果是：</p>
        <pre><code>{
   path: ['user','set']
   ,search: {uid: 123, type: 1}
   ,href: 'user/set/uid=123/type=1'
   ,hash: 'xxx'
  }
  </code></pre>
        <p>可以看到，不同的结构会自动归纳到相应的参数中，其中：</p>
        <blockquote>
          <ul>
            <li>path：存储的是路由的目录结构</li>
            <li>search：存储的是路由的参数部分</li>
            <li>href：存储的是 layuiAdmin 的完整路由地址</li>
            <li>hash：存储的是 layuiAdmin 自身的锚记，跟系统自带的 <code>location.hash</code> 有点类似</li>
          </ul>
        </blockquote>
        <p>通过 <code>layui.router()</code> 得到路由对象后，你就可以对页面进行个性化操作、异步参数传值等等。如：</p>
        <pre><code>//在 JS 中获取路由参数
  var router = layui.router();
  admin.req({
    url: 'xxx'
    ,data: {
      uid: router.search.uid
    }
  });
  </code></pre>
        <pre><code>&lt;!--  在动态模板中获取路由参数 --&gt;
  &lt;script type=&quot;text/html&quot; template lay-url=&quot;./xxx/?uid={{ layui.router().search.uid }}&quot;&gt;
    …
  &lt;/script&gt;

  &lt;!-- 或 --&gt;
  &lt;script type=&quot;text/html&quot; template lay-url=&quot;./xxx/&quot; lay-data=&quot;{uid:'{{ layui.router().search.uid }}'}&quot;&gt;
    …
  &lt;/script&gt;
  </code></pre>
        <p><a name="router-jump"> </a></p>
        <h3>路由跳转</h3>
        <p>通过上文的路由规则，你已经大致清楚了 layuiAdmin 路由的基本原理和解析方法。那么如何完成路由的跳转呢？</p>
        <ol>
          <li>在视图文件的 HTML 代码中，通过对任意元素设定 <code>lay-href=&quot;/user/set/uid=123/type=1&quot;</code>
            ，<strong>好处是</strong>：任意元素都可以触发跳转。<strong>缺点是</strong>：只能在浏览器当前选项卡完成跳转（注意：不是 layuiAdmin 的选项卡）</li>
          <li>直接对 a 标签设定 href，如： <code>&lt;a href=&quot;#/user/set&quot;&gt;text&lt;/a&gt;</code>
            。<strong>好处是</strong>：你可以通过设定 <code>target=&quot;_blank&quot;</code> 来打开一个浏览器新选项卡。<strong>缺点是</strong>：只能设置
            <code>a</code> 标签，且前面必须加 <code>/#/</code></li>
          <li>在 JS 代码中，还可通过 <code>location.hash = '/user/set';</code> 来跳转。前面无需加 <code>#</code>，它会自动追加。</li>
        </ol>
        <p><a name="router-end"> </a></p>
        <h3>路由结尾</h3>
        <p>在路由结尾部分出现的 <code>/</code> 与不出现，是两个完全不同的路由。比如下面这个：</p>
        <ol>
          <li>user/set<br>
            读取的视图文件是：.views/user/set.html</li>
          <li>user/set/<br>
            读取的视图文件是：./views/user/set/index.html （TIPS：这里的 <em>index.html</em> 即是目录下的默认主视图，下文会有讲解）</li>
        </ol>
        <p>因此一定要注意结尾处的 <code>/</code>，避免视图读取错误。</p>
        <p><a name="views"> </a></p>
        <h2>视图</h2>
        <p>这或许是你应用 layuiAdmin 时的主要焦点，在开发过程中，你的大部分精力都可能会聚焦在这里。它取代了服务端 MVC 架构中的 <em>view</em> 层，使得应用开发变得更具扩展性。因此如果你采用
          layuiAdmin 的 SPA（单页应用）模式，请务必要抛弃服务端渲染视图的思想，让页面的控制权限重新回归到前端吧！</p>
        <blockquote>
          <p><strong>views</strong> 目录存放的正是视图文件，你可以在该目录添加任意的新目录和新文件，通过对应的路由即可访问。</p>
        </blockquote>
        <p>注意：如果是单页面模式，视图文件通常是一段 HTML 碎片，而不能是一个完整的 html 代码结构。</p>
        <p><a name="views-router"> </a></p>
        <h3>视图与路由的关系</h3>
        <p>每一个视图文件，都对应一个路由。其中 <code>index.html</code> 是默认文件（你也可以通过 config.js 去重新定义）。视图文件的所在目录决定了路由的访问地址，如：</p>
        <table class="layui-table">
          <thead>
            <tr>
              <th>视图路径</th>
              <th style="text-align:left">对应的路由地址</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td>./views/user/index.html</td>
              <td style="text-align:left">/user/</td>
            </tr>
            <tr>
              <td>./views/user.html</td>
              <td style="text-align:left">/user</td>
            </tr>
            <tr>
              <td>./views/user/set/index.html</td>
              <td style="text-align:left">/user/set/</td>
            </tr>
            <tr>
              <td>./views/user/set.html</td>
              <td style="text-align:left">/user/set</td>
            </tr>
            <tr>
              <td>./views/user/set/base.html</td>
              <td style="text-align:left">/user/set/base</td>
            </tr>
          </tbody>
        </table>
        <p>通过上述的表格列举的对应关系，可以总结出：</p>
        <ul>
          <li>当视图文件是 index.html，那么路由地址就是它的上级目录（相对 <em>views</em>），以 <code>/</code> 结尾</li>
          <li>当视图文件不是 index.html，那么路由地址就是它的上级目录+视图文件名，不以 <code>/</code> 结尾</li>
        </ul>
        <blockquote>
          <p>值得注意的是：路由路径并非最多只能三级，它可以无限极。但对应的视图也必须存放在相应的层级目录下</p>
        </blockquote>
        <p><a name="views-js"> </a></p>
        <h3>视图中加载 JS 模块</h3>
        <p>在视图文件中，除了写 HTML，也可以写 JavaScript 代码。如：</p>
        <pre><code>&lt;div id=“LAY-demo-hello”&gt;Hello layuiAdmin&lt;/div&gt;
  &lt;script&gt;
  layui.use('admin', function(){
    var $ = layui.jquery;
    admin.popup({
      content: $('#LAY-demo-hello').html()
    });
  });
  &lt;/script&gt;
  </code></pre>
        <p>如果该视图对应的 JS 代码量太大，我们更推荐你在 <em>controller</em> 目录下新增一个业务模块，并在视图中直接 layui.use 去加载该模块。下面以控制台主页
          <code>index.html</code> 为例：</p>
        <pre><code>&lt;div&gt;html区域&lt;div&gt;

  &lt;script&gt;
  //加载 controller 目录下的对应模块
  /*
    小贴士：
      这里 console 模块对应 的 console.js 并不会重复加载，
      然而该页面的视图可能会重新插入到容器，那如何保证脚本能重新控制视图呢？有两种方式：
        1): 借助 layui.factory 方法获取 console 模块的工厂（回调函数）给 layui.use
        2): 直接在 layui.use 方法的回调中书写业务代码，即:
            layui.use('console', function(){
              //同 console.js 中的 layui.define 回调中的代码
            });

    这里我们采用的是方式1。其它很多视图中采用的其实都是方式2，因为更简单些，也减少了一个请求数。

  */
  layui.use('console', layui.factory('console'));
  &lt;/script&gt;
  </code></pre>
        <p>当视图被渲染后，layui.factory 返回的函数也会被执行，从而保证在不重复加载 JS 模块文件的前提下，保证脚本能重复执行。</p>
        <p><a name="template"> </a></p>
        <h2>动态模板</h2>
        <p>layuiAdmin 的视图是一个“动静结合”的载体，除了常规的静态模板，你当然还可以在视图中存放动态模板，因此它可谓是焦点中的焦点。</p>
        <p><a name="template-set"> </a></p>
        <h3>定义模板</h3>
        <p>在视图文件中，通过下述规则定义模板：</p>
        <pre><code>&lt;script type=&quot;text/html&quot; template&gt;
    &lt;!-- 动态模板碎片 --&gt;
  &lt;/script&gt;
  </code></pre>
        <p>下面是一个简单的例子：</p>
        <pre><code>&lt;script type=&quot;text/html&quot; template&gt;
    当前 layuiAdmin 的版本是：{{ layui.admin.v }}
    路由地址：{{ layui.router().href }}
  &lt;/script&gt;
  </code></pre>
        <p>在不对动态模板设定数据接口地址的情况下，它能读取到全局对象。但更多时候，一个动态模板应该是对应一个接口地址，如下所示：</p>
        <pre><code>&lt;script type=&quot;text/html&quot; template lay-url=&quot;接口地址&quot;&gt;
      我叫：{{ d.data.username }}
      {{# if(d.data.sex === '男'){ }}
          公的
      {{# } else { }}
          母的
      {{# } }}
  &lt;/script&gt;
  </code></pre>
        <p>模板中的 <code>d</code> 对应的是你接口返回的 json 转化后的一维对象，如：</p>
        <pre><code>{
    &quot;code&quot;: 0
    ,&quot;data&quot;: {
      &quot;username&quot;: &quot;贤心&quot;
      ,&quot;sex&quot;: &quot;男&quot;
    }
  }
  </code></pre>
        <p>那么，上述动态模板最终输出的结果就是：</p>
        <pre><code>我叫：贤心
  公的
  </code></pre>
        <p><a name="template-attrs"> </a></p>
        <h3>模板基础属性</h3>
        <p>动态模板支持以下基础属性</p>
        <ul>
          <li><strong>lay-url</strong><br>
            用于绑定模板的数据接口地址，支持动态模板解析，如：</li>
        </ul>
        <pre><code>&lt;script type=&quot;text/html&quot; template lay-url=&quot;https://api.xxx.com?id={{ layui.router().search.id }}&quot;&gt;
    &lt;!-- 动态模板碎片 --&gt;
  &lt;/script&gt;
  </code></pre>
        <ul>
          <li><strong>lay-type</strong><br>
            用于设定模板的接口请求类型（默认：get），如：</li>
        </ul>
        <pre><code>&lt;script type=&quot;text/html&quot; template lay-url=&quot;接口地址&quot; lay-type=&quot;post&quot;&gt;
    &lt;!-- 动态模板碎片 --&gt;
  &lt;/script&gt;
  </code></pre>
        <ul>
          <li><strong>lay-data</strong><br>
            用于定义接口请求的参数，其值是一个 JavaScript object 对象，同样支持动态模板解析，如：</li>
        </ul>
        <pre><code>&lt;script type=&quot;text/html&quot; template lay-url=&quot;接口地址&quot; lay-data=&quot;{id: '{{ layui.router().search.id }}', type: 1}&quot;&gt;
    &lt;!-- 动态模板碎片 --&gt;
  &lt;/script&gt;
  </code></pre>
        <ul>
          <li>
            <p><strong>lay-headers</strong><br>
              用户定义接口请求的 Request Headers 参数，用法与 lay-data 的完全类似，支持动态模板解析。</p>
          </li>
          <li>
            <p><strong>lay-done</strong><br>
              接口请求完毕并完成视图渲染的回调脚本，里面支持写任意的 JavaScript 语句。事实上它是一个封闭的函数作用域，通过给 Function 实例返回的函数传递一个参数
              <code>d</code>，用于得到接口返回的数据：</p>
          </li>
        </ul>
        <pre><code>&lt;script type=&quot;text/html&quot; template lay-url=&quot;接口地址&quot; lay-done=&quot;console.log(d);&quot;&gt;
    &lt;!-- 动态模板碎片 --&gt;
  &lt;/script&gt;
  </code></pre>
        <p>很多时候，你在动态模板中可能会放入一些类似于 layui 的 form 元素，而有些控件需要执行 <code>form.render()</code> 才会显示，这时，你可以对 lay-done 赋值一个全局函数，如：
        </p>
        <pre><code>&lt;script type=&quot;text/html&quot; template lay-url=&quot;接口地址&quot; lay-done=&quot;layui.data.done(d);&quot;&gt;
     &lt;div class=&quot;layui-form&quot; lay-filter=&quot;LAY-filter-demo-form&quot;&gt;
       &lt;input type=&quot;checkbox&quot; title=&quot;复选框&quot;&gt;
    &lt;/div&gt;
  &lt;/script&gt;

  &lt;!--  注意：别看眼花了，下面可不是动态模板，而是 JS 脚本区域 --&gt;
  &lt;script&gt;
  layui.data.done = function(d){
    layui.use(['form'], function(){
      var form = layui.form;
       form.render(null, 'LAY-filter-demo-form'); //渲染该模板下的动态表单
    });
  };
  &lt;/script&gt;
  </code></pre>
        <p>TIPS：</p>
        <blockquote>
          <ul>
            <li>如果模板渲染完毕需要处理过多的交互，我们强烈推荐你采用上述的方式定义一个全局函数赋值给 lay-done，会极大地减少维护成本。</li>
            <li>无需担心该全局函数的冲突问题，该函数是一次性的。其它页面即便声明了一个同样的函数，也只是用于新的视图，丝毫不会对之前的视图造成任何影响。</li>
            <li>layui.data.done 中的 <em>done</em> 可以随意命名，但需与 lay-done 的赋值对应上。</li>
          </ul>
        </blockquote>
        <p><a name="template-syntax"> </a></p>
        <h3>模板语法</h3>
        <p>动态模板基于 layui 的 laytpl 模块，详细语法可见：<br>
          <a
            href="http://www.layui.com/doc/modules/laytpl.html#syntax">http://www.layui.com/doc/modules/laytpl.html#syntax</a>
        </p>
        <p><a name="login-auth"> </a></p>
        <h2>登录与接口鉴权</h2>
        <p>由于 layuiAdmin 接管了视图层，所以不必避免可能会与服务端分开部署，这时你有必要了解一下 layuiAdmin 默认提供的：从 <em>登录</em> 到 <em>接口鉴权</em>，再到
          <em>注销</em> 的整个流程。</p>
        <h3>登录拦截器</h3>
        <p>进入登入页面登入成功后，会在 localStorage 的本地表中写入一个字段。如： access_token （名称可以在 config.js 自定义）。拦截器判断没有 access_token
          时，则会跳转到登入页。尽管可以通过伪造一个假的 access_token 绕过视图层的拦截，但在请求接口时，会自动带上 access_token，服务端应再次做一层校验。</p>
        <h3>流程</h3>
        <ol>
          <li>打开 <code>config.js</code> ，将 <code>interceptor</code> 参数设置为 <code>true</code>（该参数为 1.0.0-beta6
            开始新增）。那么，当其未检查到 <code>access_token</code> 值时，会强制跳转到登录页面，以获取 access_token。</li>
          <li>打开登录对应的视图文件 <code>views/user/login.html</code>，在代码最下面，你将看到一段已经写好的代码，你需要的是将接口地址改为服务端的真实接口，并返回
            <code>access_token</code> 值。</li>
          <li>layuiAdmin 会将服务端返回的 <code>access_token</code> 值进行本地存储，这时你会发现 layuiAdmin
            不再强制跳转到登录页面。并在后面每次请求服务端接口时，都会自动在参数和 Request Headers 中带上 <code>access_token</code>，以便服务端进行鉴权。</li>
          <li>若鉴权成功，顺利返回数据；若鉴权失败，服务端的 <code>code</code> 应返回 <code>1001</code>（可在 config.js 自定义） ， layuiAdmin 将会自动清空本地无效
            token 并跳转到登入页。</li>
          <li>退出登录：重新打开 <code>controller/common.js</code>，搜索 <code>logout</code>，配上注销接口即可。</li>
        </ol>
        <blockquote>
          <p>如果是在其它场景请求的接口，如：table.render()，那么你需要获取本地存储的 token 赋值给接口参数，如下：</p>
        </blockquote>
        <pre><code>//设置全局 table 实例的 token（这样一来，所有 table 实例均会有效）
  table.set({
    headers: { //通过 request 头传递
      access_token: layui.data('layuiAdmin').access_token
    }
    ,where: { //通过参数传递
      access_token: layui.data('layuiAdmin').access_token
    }
  });


  //设置单个 table 实例的 token
  table.render({
    elem: '#xxxx'
    ,url: 'url'
    ,where: {
      access_token: layui.data('layuiAdmin').access_token
    }
    //,headers: {}
  });
  </code></pre>
        <p>事实上，layuiAdmin 的所有 Ajax 请求都是采用 <code>admin.req(options)</code>，它会自动传递 <code>access_token</code>，因此推荐你在 JS 执行
          Ajax 请求时直接使用它。其中参数 <em>options</em> 和 <code>$.ajax(options)</code> 的参数完全一样。</p>
        <h3>接口鉴权</h3>
        <p>我们推荐服务端遵循 <strong>JWT</strong>（JSON Web Token） 标准进行鉴权。对 JWT 不甚了解的同学，可以去搜索一些相关资料，会极大地增加应用的可扩展性。当然，你也可以直接采用传统的
          cookie / session 机制。</p>
        <p><a name="base-mehod"> </a></p>
        <h2>基础方法</h2>
        <ul>
          <li><strong>config 模块</strong></li>
        </ul>
        <blockquote>
          <p>你可以在任何地方通过 <code>layui.setter</code> 得到 <em>config.js</em> 中的配置信息</p>
        </blockquote>
        <p><a name="base-admin"> </a></p>
        <ul>
          <li><strong>admin 模块</strong></li>
        </ul>
        <blockquote>
          <p>var admin = layui.admin;</p>
        </blockquote>
        <ul>
          <li>
            <p><strong>admin.req(options)</strong><br>
              Ajax 请求，用法同 $.ajax(options)，只是该方法会进行错误处理和 token 的自动传递</p>
          </li>
          <li>
            <p><strong>admin.screen()</strong><br>
              获取屏幕类型，根据当前屏幕大小，返回 0 - 3 的值<br>
              0: 低于768px的屏幕<br>
              1：768px到992px之间的屏幕<br>
              2：992px到1200px之间的屏幕<br>
              3：高于1200px的屏幕</p>
          </li>
          <li>
            <p><strong>admin.exit()</strong><br>
              清除本地 token，并跳转到登入页</p>
          </li>
          <li>
            <p><strong>admin.sideFlexible(status)</strong><br>
              侧边伸缩。status 为 null：收缩；status为 “spread”：展开</p>
          </li>
          <li>
            <p><strong>admin.on(eventName, callback)</strong><br>
              事件监听，下文会有讲解</p>
          </li>
          <li>
            <p><strong>admin.popup(options)</strong><br>
              弹出一个 layuiAdmin 主题风格的 layer 层，参数 options 跟 layer.open(options) 完全相同</p>
          </li>
          <li>
            <p><strong>admin.popupRight(options)</strong><br>
              在屏幕右侧呼出一个面板层。options 同上。</p>
          </li>
        </ul>
        <pre><code>admin.popupRight({
    id: 'LAY-popup-right-new1' //定义唯一ID，防止重复弹出
    ,success: function(){
      //将 views 目录下的某视图文件内容渲染给该面板
      layui.view(this.id).render('视图文件所在路径');
    }
  });
  </code></pre>
        <ul>
          <li>
            <p><strong>admin.resize(callback)</strong><br>
              窗口 resize 事件处理，我们推荐你使用该方法取代 jQuery 的 resize 事件，以避免多页面标签下可能存在的冲突。</p>
          </li>
          <li>
            <p><strong>admin.fullScreen()</strong><br>
              全屏</p>
          </li>
          <li>
            <p><strong>admin.exitScreen()</strong><br>
              退出全屏</p>
          </li>
          <li>
            <p><strong>admin.events</strong></p>
            <ul>
              <li>
                <p>admin.events.refresh()<br>
                  刷新当前右侧区域</p>
              </li>
              <li>
                <p>admin.events.closeThisTabs()<br>
                  关闭当前标签页</p>
              </li>
              <li>
                <p>admin.events.closeOtherTabs()<br>
                  关闭其它标签页</p>
              </li>
              <li>
                <p>admin.events.closeAllTabs()<br>
                  关闭全部标签页</p>
              </li>
            </ul>
          </li>
        </ul>
        <p><a name="base-view"> </a></p>
        <ul>
          <li><strong>view 模块</strong></li>
        </ul>
        <blockquote>
          <p>var view = layui.view;</p>
        </blockquote>
        <ul>
          <li><strong>view(id)</strong><br>
            获取指定容器，并返回一些视图渲染的方法，如：</li>
        </ul>
        <pre><code>//渲染视图，viewPath 即为视图路径
  view('id').render(viewPath).then(function(){
      //视图文件请求完毕，视图内容渲染前的回调
  }).done(function(){
     //视图文件请求完毕和内容渲染完毕的回调
  });

  //直接向容器插入 html，tpl 为 模板字符；data 是传入的数据。该方法会自动完成动态模板解析
  view('id').send(tpl, data);
  </code></pre>
        <p>另外，<code>render</code> 方法支持动态传参，以用于视图内容接受。如：</p>
        <pre><code>admin.popup({
    id: 'LAY-popup-test1'
    ,success: function(){
      view(this.id).render('视图文件所在路径', {
         id: 123 //这里的 id 值你可以在一些事件中动态获取（如 table 模块的编辑）
      });
    }
  });
  </code></pre>
        <p>那么，在视图文件中，你可以在动态模板中通过 <code>{{ d.params.xxx }}</code> 得到传入的参数，如：</p>
        <pre><code>&lt;script type=&quot;text/html&quot; template lay-url=&quot;http://api.com?id={{ d.params.id }}&quot;&gt;
    配置了接口的动态模板，且接口动态获取了 render 传入的参数：{{ d.params.id }}
  &lt;/script&gt;

  &lt;script type=&quot;text/html&quot; template&gt;
    也可以直接获取：&lt;input type=&quot;hidden&quot; name=&quot;id&quot; value=&quot;{{ d.params.id }}&quot;&gt;
  &lt;/script&gt;
  </code></pre>
        <p><strong>而如果是在 JS 语句中去获取模板传递过来的变量，可以借助动态模板的 lay-done 属性去实现，如：</strong></p>
        <pre><code>&lt;script type=&quot;text/html&quot; template lay-done=&quot;layui.data.sendParams(d.params)&quot;&gt;

  &lt;/script&gt;
  </code></pre>
        <p>然后在 JS 语句中通过执行动态模板 lay-done 中对应的方法得到对应的参数值：</p>
        <pre><code>&lt;script&gt;
  //定义一个 lay-done 对应的全局方法，以供动态模板执行
  layui.data.sendParams = function(params){
    console.log(params.id) //得到传递过来的 id 参数（或其他参数）值

    //通过得到的参数值，做一些你想做的事
    //…

    //若需用到 layui 组件，layui.use 需写在该全局方法里面，如：
    layui.use(['table'], function(){
      var table = layui.table;
      table.render({
        elem: ''
        ,url: 'url?id='+ params.id
      });
    });
  };
  &lt;/script&gt;
  </code></pre>
        <blockquote>
          <p>注意：上述实现需保证 layuiAdmin 为 <strong>1.2.0+</strong>`</p>
        </blockquote>
        <p>总之，驾驭好 <code>view().render().done(callback)</code> 对您的项目开发至关重要。</p>
        <p><a name="id"> </a></p>
        <h2>ID唯一性</h2>
        <p>如果你开启了标签页功能，请务必注意 ID 的冲突，尤其是在你自己绑定事件的情况。ID 的命令可以遵循以下规则来规避冲突：</p>
        <pre><code>LAY-路由-任意名
  </code></pre>
        <p>以<em>消息中心</em>页面为例，假设它的路由为：<code>/app/message/</code>，那么 ID 应该命名为：</p>
        <pre><code>&lt;button class=&quot;layui-btn&quot; id=&quot;LAY-app-message-del&quot;&gt;删除&lt;/button&gt;
  </code></pre>
        <p><a name="util"> </a></p>
        <h2>实用组件</h2>
        <h3>Hover 提示层</h3>
        <p>通过对元素设置 <code>lay-tips=&quot;提示内容&quot;</code> 来开启一个 hover 提示，如：</p>
        <pre><code>&lt;i class=&quot;layui-icon layui-icon-tips&quot; lay-tips=&quot;要支持的噢&quot; lay-offset=&quot;5&quot;&gt;&lt;/i&gt;
  </code></pre>
        <p>其中 <code>lay-offset</code> 用于定于水平偏移距离（单位px），以调整箭头让其对准元素</p>
        <p><a name="on"> </a></p>
        <h2>事件监听</h2>
        <ul>
          <li><strong>hash</strong><br>
            监听路由地址改变</li>
        </ul>
        <pre><code>// 下述中的 xxx 可随意定义，不可与已经定义的 hash 事件同名，否则会覆盖上一事件
  admin.on('hash(xxx)', function(router){
    console.log(router); //得到路由信息
  });
  </code></pre>
        <ul>
          <li><strong>side</strong><br>
            监听侧边伸缩</li>
        </ul>
        <pre><code>// 下述中的 xxx 可随意定义，不可与已经定义的 side 事件同名，否则会覆盖上一事件
  admin.on('side(xxx)', function(obj){
    console.log(obj.status); //得到伸缩状态：spread 为展开状态，其它值为收缩状态
  });
  </code></pre>
        <p><a name="compatibility"> </a></p>
        <h2>兼容性</h2>
        <p>layuiAdmin 使用到了 layui 的栅格系统，而栅格则是基于浏览器的媒体查询。ie8、9不支持。<br>
          所以要在宿主页面（如 start/index.html ）加上下面这段保证兼容：</p>
        <pre><code class="language-html">&lt;!-- 让IE8/9支持媒体查询，从而兼容栅格 --&gt;
  &lt;!--[if lt IE 9]&gt;
    &lt;script src=&quot;https://cdn.staticfile.org/html5shiv/r29/html5.min.js&quot;&gt;&lt;/script&gt;
    &lt;script src=&quot;https://cdn.staticfile.org/respond.js/1.4.2/respond.min.js&quot;&gt;&lt;/script&gt;
  &lt;![endif]--&gt;

  </code></pre>
        <p><a name="cache"> </a></p>
        <h2>缓存问题</h2>
        <p>
          由于单页面版本的视图文件和静态资源模块都是动态加载的，所以可能存在浏览器的本地缓存问题，事实上我们也考虑到这个，因此，为了避免改动后的文件未及时生效，你只需在入口页面（默认为<code>start/index.html</code>）中，找到
          <code>layui.config</code> ，修改其 <code>version</code> 的值即可。</p>
        <blockquote>
          <p><strong>我们推荐你分场景来更新缓存：</strong></p>
          <ul>
            <li>场景一：如果项目是在本地开发。你可以设置 version 为动态毫秒数，如：</li>
          </ul>
          <pre><code>version: new Date().getTime() //这样你每次刷新页面，都会更新一次缓存
  </code></pre>
          <hr>
          <ul>
            <li>场景二：如果项目是在线上运行。建议你手工更新 <code>version</code>，如：</li>
          </ul>
          <pre><code>version: '1.0.0' //每次发布项目时，跟着改动下该属性值即可更新静态资源的缓存
  </code></pre>
        </blockquote>
        <p><a name="update"> </a></p>
        <h2>升级事项</h2>
        <p>从官网更新资源包后，除了 src 和 dist 目录需要注意一下，其它目录和文件均可覆盖，下面以 src 为例（dist 由于是 src 构建后生成的目录，所以本质是和 src 一样的）<br>
          <strong>src 目录下可以直接覆盖的有</strong>：</p>
        <blockquote>
          <ul>
            <li>src/lib/</li>
            <li>src/style/</li>
            <li>src/index.js</li>
          </ul>
        </blockquote>
        <p><strong>需要灵活调配的有</strong>：</p>
        <blockquote>
          <ul>
            <li>src/controller/</li>
            <li>src/views/</li>
            <li>src/config.js<br>
              如果没有改动默认配置，事实上 config.js 也可以覆盖升级</li>
          </ul>
        </blockquote>
        <p>开发过程中，建议同时运行两个 layuiAdmin 。一个是已经实际运用的，一个是 layuiAdmin 本身的 Demo。以便从 Demo 中获取参考和提取示例。</p>
        <p><a name="build"> </a></p>
        <h2>源码构建</h2>
        <blockquote>
          <p>当你在 src 目录完成开发后，你可通过 gulp 对 src 源码进行自动化构建，以生成用于线上环境的 dist 目录。并在入口页面中的 <code>layui.config</code> 的 base 参数指向
            dist。</p>
        </blockquote>
        <p>在资源包中根目录下看到的 gulpfile.js 是 layuiAdmin 写好的任务脚本，package.json 是任务配置文件，你只需按照以下步骤：</p>
        <ol>
          <li>step1：确保你的电脑已经安装好了 <a href="https://nodejs.org/en/">Node.js</a>，如果未安装，可去官网下载安装</li>
          <li>step2: 命令行安装 gulp：npm install gulp -g</li>
          <li>step3：切换到 layuiAdmin 项目根目录（即 gulpfile.js 所在目录），命令行安装任务所依赖的包：npm install</li>
        </ol>
        <p>安装完成后，后续只需直接执行命令：<code>gulp</code> 即可完成 src 到 dist 目录的构建</p>
        <p><a name="copyright"> </a></p>
        <h2>关于版权</h2>
        <blockquote>
          <p>layuiAdmin 受国家计算机软件著作权保护，未经官网正规渠道授权擅自公开产品源文件、以及直接对产品二次出售的，我们将追究相应的法律责任。</p>
        </blockquote>
        <p>© 2019 <a href="http://www.layui.com/admin/">layui.com</a> 版权所有</p>
        <i icon="0.00004236603749947042"></i>
      </div>
    </div>
  </div>
  <div id="FLY-spread-dir" class="layui-hide"> <i class="layui-icon layui-icon-spread-left"></i></div>

  <script src="/layui/layui.js?t=1568266997720"></script>
  <script>var _hmt = _hmt || []; (function () { var hm = document.createElement("script"); hm.src = "https://hm.baidu.com/hm.js?d214947968792b839fd669a4decaaffc"; var s = document.getElementsByTagName("script")[0]; s.parentNode.insertBefore(hm, s); })();</script>
</body>

</html>
